forked from CleverRaven/Cataclysm-DDA
-
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.
Initial Brights Nights readme (CleverRaven#50)
* Initial readme for BN Initial readme for BN * update update * update update * update update * update update * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md Co-authored-by: firestorm01x2 <firestorm01x2gmail.com>
- Loading branch information
1 parent
031dc9c
commit 4362ed4
Showing
1 changed file
with
22 additions
and
50 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 |
|---|---|---|
| @@ -1,47 +1,27 @@ | ||
| # Cataclysm: Dark Days Ahead | ||
| # Cataclysm: Bright Nights | ||
|
|
||
| Cataclysm: Dark Days Ahead is a roguelike set in a post-apocalyptic world. While some have described it as a "zombie game", there is far more to Cataclysm than that. Struggle to survive in a harsh, persistent, procedurally generated world. Scavenge the remnants of a dead civilization for food, equipment, or, if you are lucky, a vehicle with a full tank of gas to get you the hell out of Dodge. Fight to defeat or escape from a wide variety of powerful monstrosities, from zombies to giant insects to killer robots and things far stranger and deadlier, and against the others like yourself, who want what you have... | ||
| Cataclysm: Bright Nights is a roguelike with sci-fi elements set in a post-apocalyptic world. | ||
|
|
||
| <a href="https://repology.org/project/cataclysm-dda/versions"> | ||
| <img src="https://repology.org/badge/vertical-allrepos/cataclysm-dda.svg" alt="Packaging Status" align="right"> | ||
| </a> | ||
|
|
||
| [](https://travis-ci.org/CleverRaven/Cataclysm-DDA) | ||
| [](https://coveralls.io/github/CleverRaven/Cataclysm-DDA?branch=master) | ||
| [](https://lgtm.com/projects/g/CleverRaven/Cataclysm-DDA/context:cpp) | ||
| [](https://www.codetriage.com/cleverraven/cataclysm-dda) | ||
| [](https://github.com/CleverRaven/Cataclysm-DDA/graphs/contributors) | ||
| [](https://github.com/XAMPPRocky/tokei) | ||
| While some have described it as a "zombie game", there is far more to Cataclysm than that. Struggle to survive in a harsh, persistent, procedurally generated world. Scavenge the remnants of a dead civilization for food, equipment, or, if you are lucky, a vehicle with a full tank of gas to get you the hell out of there. | ||
|
|
||
| ## Downloads | ||
|
|
||
| **Releases** - [Stable](https://cataclysmdda.org/releases/) | [Experimental](https://cataclysmdda.org/experimental/) | ||
|
|
||
| **Source** - The source can be downloaded as a [.zip archive](https://github.com/CleverRaven/Cataclysm-DDA/archive/master.zip), or cloned from our [GitHub repo](https://github.com/CleverRaven/Cataclysm-DDA/). | ||
|
|
||
| ### Packaging status | ||
|
|
||
| #### Arch Linux | ||
| Fight to defeat or escape from a wide variety of powerful monstrosities, from zombies to giant insects to killer robots and things far stranger and deadlier, and against the others like yourself, who want what you have. | ||
|
|
||
| Ncurses and tiles version available in [community repo](https://www.archlinux.org/packages/?q=cataclysm-dda). | ||
|
|
||
| `sudo pacman -S cataclysm-dda` | ||
| Find a way to stop the Cataclysm ... or become one of its strongest monsters. | ||
|
|
||
| #### Fedora | ||
|
|
||
| Ncurses and tiles version available in [official repos](https://src.fedoraproject.org/rpms/cataclysm-dda). | ||
|
|
||
| `sudo dnf install cataclysm-dda` | ||
| ## Downloads | ||
|
|
||
| #### Debian / Ubuntu | ||
| **Releases** - (https://github.com/cataclysmbnteam/Cataclysm-BN/releases) | ||
|
|
||
| Ncurses and tiles version available in [official repos](https://tracker.debian.org/pkg/cataclysm-dda). | ||
| **Source** - The source can be downloaded as a [.zip archive](https://github.com/cataclysmbnteam/Cataclysm-BN/archive/master.zip), or cloned from our [GitHub repo](https://github.com/cataclysmbnteam/Cataclysm-BN/). | ||
|
|
||
| `sudo apt install cataclysm-dda-curses cataclysm-dda-sdl` | ||
|
|
||
| ## Compile | ||
|
|
||
| Please read [COMPILING.md](doc/COMPILING/COMPILING.md) - it covers general information and more specific recipes for Linux, OS X, Windows and BSD. See [COMPILER_SUPPORT.md](doc/COMPILING/COMPILER_SUPPORT.md) for details on which compilers we support. And you can always dig for more information in [doc/](https://github.com/CleverRaven/Cataclysm-DDA/tree/master/doc). | ||
| Please read [COMPILING.md](doc/COMPILING/COMPILING.md) - it covers general information and more specific recipes for Linux, OS X, Windows and BSD. See [COMPILER_SUPPORT.md](doc/COMPILING/COMPILER_SUPPORT.md) for details on which compilers we support. And you can always dig for more information in [doc/](https://github.com/cataclysmbnteam/Cataclysm-BN/tree/upload/doc). | ||
|
|
||
| We also have the following build guides: | ||
| * Building on Windows with `MSYS2` at [COMPILING-MSYS.md](doc/COMPILING/COMPILING-MSYS.md) | ||
|
|
@@ -50,30 +30,26 @@ We also have the following build guides: | |
|
|
||
| ## Contribute | ||
|
|
||
| Cataclysm: Dark Days Ahead is the result of contributions from over 1000 volunteers under the Creative Commons Attribution ShareAlike 3.0 license. The code and content of the game is free to use, modify, and redistribute for any purpose whatsoever. See http://creativecommons.org/licenses/by-sa/3.0/ for details. | ||
| Cataclysm: Bright Nights developed under Creative Commons Attribution ShareAlike 3.0 license. The code and content of the game is free to use, modify, and redistribute for any purpose whatsoever. See http://creativecommons.org/licenses/by-sa/3.0/ for details. | ||
| Some code distributed with the project is not part of the project and is released under different software licenses, the files covered by different software licenses have their own license notices. | ||
|
|
||
| [<img src="https://www.bountysource.com/badge/tracker?tracker_id=146201" alt="Bountysource" align="right">](https://www.bountysource.com/trackers/146201-clever-raven-cataclysm-dda?utm_source=146201&utm_medium=shield&utm_campaign=TRACKER_BADGE) | ||
|
|
||
| Please see [CONTRIBUTING.md](https://github.com/CleverRaven/Cataclysm-DDA/blob/master/.github/CONTRIBUTING.md) for details. | ||
| Please see [CONTRIBUTING.md](https://github.com/cataclysmbnteam/Cataclysm-BN/blob/upload/.github/CONTRIBUTING.md) for details. | ||
|
|
||
| ## Community | ||
|
|
||
| Forums: | ||
| https://discourse.cataclysmdda.org | ||
| GitHub repo: | ||
| https://github.com/cataclysmbnteam/Cataclysm-BN | ||
|
|
||
| Wiki: | ||
| http://cddawiki.chezzo.com/cdda_wiki/index.php | ||
| Check out the BN channel on DDA discord: | ||
| https://discord.gg/jFEc7Yp | ||
|
|
||
| GitHub repo: | ||
| https://github.com/CleverRaven/Cataclysm-DDA | ||
|
|
||
| IRC: | ||
| `irc.freenode.net` ; `#CataclysmDDA` | ||
| http://webchat.freenode.net/?channels=#CataclysmDDA | ||
|
|
||
| Official Discord: | ||
| https://discord.gg/jFEc7Yp | ||
| There are also BN channels on the following discords: | ||
|
|
||
| https://discord.gg/nudv6B | ||
|
|
||
| https://discord.gg/WDCZW7 | ||
|
|
||
| ## Frequently Asked Questions | ||
|
|
||
|
|
@@ -91,12 +67,8 @@ Press the `?` key, followed by the `1` key to see the full list of key commands. | |
|
|
||
| #### I've found a bug. What should I do? | ||
|
|
||
| Please submit an issue on [our GitHub page](https://github.com/CleverRaven/Cataclysm-DDA/issues/) using [bug report template](https://github.com/CleverRaven/Cataclysm-DDA/issues/new?template=bug_report.md). If you're not able to, send an email to `[email protected]`. | ||
| Please submit an issue on [our GitHub page](https://github.com/cataclysmbnteam/Cataclysm-BN/issues) using [bug report template](https://github.com/cataclysmbnteam/Cataclysm-BN/issues/new?template=bug_report.md). | ||
|
|
||
| #### I would like to make a suggestion. What should I do? | ||
|
|
||
| Please submit an issue on [our GitHub page](https://github.com/CleverRaven/Cataclysm-DDA/issues/) using [feature request template](https://github.com/CleverRaven/Cataclysm-DDA/issues/new?template=feature_request.md). | ||
|
|
||
| You can also submit your suggestions or vote for existing suggestions on [our FeatHub page](https://feathub.com/CleverRaven/Cataclysm-DDA). Most voted suggestions are: | ||
|
|
||
| [](https://feathub.com/CleverRaven/Cataclysm-DDA) | ||
| Please submit an issue on [our GitHub page](https://github.com/cataclysmbnteam/Cataclysm-BN/issues/) using [feature request template](https://github.com/cataclysmbnteam/Cataclysm-BN/issues/new?template=feature_request.md). | ||