-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Credit to audreyr/cookiecutter-pypackage for the parts on contributing.
- Loading branch information
1 parent
62980b7
commit b9dbc83
Showing
1 changed file
with
59 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,59 @@ | ||
# Counter-Strike: Global Offensive map overviews | ||
|
||
This is a collection of radar overviews, and eventually thumbnails, | ||
in more usable formats, with scripts for easily updating them. | ||
|
||
## Updating the overviews | ||
|
||
* Prepare the virtualenv: | ||
|
||
```bash | ||
virtualenv virtualenv | ||
. virtualenv/bin/activate | ||
pip install -r requirements.txt | ||
``` | ||
|
||
* Drop the `.dds` files from `common/Counter-Strike Global Offensive/csgo/resource/overviews` in | ||
`csgo-overviews/overviews/raw`. | ||
|
||
* Run the script: | ||
|
||
```bash | ||
scripts/update_overviews.py | ||
``` | ||
|
||
## Contributing | ||
|
||
Contributions are welcome, and they are greatly appreciated! Every | ||
little bit helps, and credit will always be given. | ||
|
||
### Report Bugs | ||
|
||
Report bugs using the [issue tracker](https://github.com/zoidbergwill/csgo-overviews/issues?state=open). | ||
|
||
If you are reporting a bug, please include: | ||
|
||
* Your operating system name and version. | ||
* Any details about your local setup that might be helpful in troubleshooting. | ||
* Detailed steps to reproduce the bug. | ||
|
||
### Fix Bugs | ||
|
||
Look through the GitHub issues for bugs. Anything tagged with "bug" | ||
is open to whoever wants to implement it. | ||
|
||
### Implement Features | ||
|
||
Look through the GitHub issues for features. Anything tagged with "feature" | ||
is open to whoever wants to implement it. | ||
|
||
### Submit Feedback | ||
|
||
The best way to send feedback is using the [issue tracker](https://github.com/zoidbergwill/csgo-overviews/issues?state=open) | ||
|
||
If you are proposing a feature: | ||
|
||
* Explain in detail how it would work. | ||
* Keep the scope as narrow as possible, to make it easier to implement. | ||
* Remember that this is a volunteer-driven project, and that contributions | ||
are welcome :) |