Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updated various documentation to include new preset feature #19

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,23 @@ python main.py

It’s very **simple** to use! Input the text you want to simulate, then hit **"Start Typing"**. Your text will appear in the lower input field as it's typed out, with a **progress bar** to monitor the process.

---

<div align="center">

📝 **Capabilities** ⌨️

Chainsaw Human Typing allows for several tweaks to be made about how the typing is done. Users can choose the:
<ul>
<li>Delay until typing starts</li>
<li>Interval</li>
<li>Chars per stroke</li>
<li>Mistake Percentage</li>
</ul>
along with being able to randomize the interval and choose whether enter is typed all in a GUI.
Users are also able to create different presets that save their typing settings. Current preset settings allow for unlimited presets to be created and for presets to be renamed or deleted.


---

<div align="center">
Expand Down
2 changes: 1 addition & 1 deletion docs/English/run-from-source.html
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ <h1>Running Chainsaw Human Typing from Source</h1>
<li><strong>Clone the Repository:</strong> Clone the repository using Git. Open your terminal and run:
<pre><code>git clone https://github.com/LyubomirT/chainsaw-human-typing.git</code></pre>
</li>
<li><strong>Install Dependencies:</strong> Navigate to the project directory and install the required dependencies:
<li><strong>Install Dependencies:</strong> Navigate to the project directory source and install the required dependencies:
<pre><code>pip install -r requirements.txt</code></pre>
</li>
<li><strong>Run the Application:</strong> Execute the main script to start the application:
Expand Down
8 changes: 8 additions & 0 deletions docs/English/usage.html
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,14 @@ <h1>How to Use Chainsaw Human Typing</h1>
<li><strong>Start Typing:</strong> Click the "Start Typing" button to begin the simulation. The progress will be shown in the progress bar.</li>
<li><strong>Stop Typing:</strong> If you wish to stop the simulation, click the "Stop Typing" button. This will halt the typing process immediately.</li>
</ol>
<p>Chainsaw Human Typing also supports presets so that commonly used settings can be stored and easily reused</p>
<ol>
<li><strong>Choose Desired Settings:</strong> With the application running, set all the values for the preset that you would normally use.</li>
<li><strong>Save Preset:</strong> Click the "Save Preset" button and enter a name for the preset. This will save the current settings for future use in presets.json.</li>
<li><strong>Load Preset:</strong> To load a preset, double click it from the preset menu and it will load in all the previously selected values.</li>
<li><strong>Delete Preset:</strong> To delete a preset, select it from the preset menu and press "Delete Preset".</li>
<li><strong>Rename a Preset:</strong> Presets can also be renamed by selecting them and pressing the "Rename preset" button.</li>
</ol>
</div>
<a href="index.html">Back to Home</a>
</div>
Expand Down