-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Thomas SO
committed
Apr 13, 2024
0 parents
commit 7166b88
Showing
1 changed file
with
42 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
# microtransaction-simulator-autoklicker | ||
|
||
this project is not finished yet, but the script works fine when running the game on a 108ß primary monitor | ||
|
||
## Description | ||
|
||
Here is the Steam Guide to this autoclicker | ||
https://steamcommunity.com/sharedfiles/filedetails/?id=3220589966 | ||
|
||
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors. | ||
|
||
## Visuals | ||
|
||
https://steamuserimages-a.akamaihd.net/ugc/2465232740253695088/D26B8343C7097ACD4009D466BEFE6FC77520E1A1/ | ||
|
||
## Installation | ||
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection. | ||
|
||
## Usage | ||
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README. | ||
|
||
## Support | ||
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc. | ||
|
||
## Roadmap | ||
If you have ideas for releases in the future, it is a good idea to list them in the README. | ||
|
||
## Contributing | ||
State if you are open to contributions and what your requirements are for accepting them. | ||
|
||
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self. | ||
|
||
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser. | ||
|
||
## Authors and acknowledgment | ||
Show your appreciation to those who have contributed to the project. | ||
|
||
## License | ||
For open source projects, say how it is licensed. | ||
|
||
## Project status | ||
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers. |