Skip to content

Commit 6fd2cd5

Browse files
committedAug 20, 2021
Update README.md
Updates installation instructions Table of contents "Creating a release" link now works Updates game preview gif to one with the new graphics Fixes #125
1 parent 70aeef9 commit 6fd2cd5

File tree

1 file changed

+6
-8
lines changed

1 file changed

+6
-8
lines changed
 

‎README.md

+6-8
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ NeoMori is a summer project exploring contemporary software development and DevO
1212
- [Project flow](#project-flow)
1313
- [License](#license)
1414

15-
![NeoMori_Dashing](https://user-images.githubusercontent.com/62639702/126960849-7fe79e43-6ff5-489e-8cad-0f4ac8e0ca6a.gif "NeoMori Dashing")
15+
![NeoMori_Preview](https://user-images.githubusercontent.com/62639702/130251239-f00fed33-7242-4c85-9a87-3bf3df3015b0.gif "NeoMori Preview")
1616

1717
## Project goals <a name="project-goals"/>
1818

@@ -29,16 +29,14 @@ Underlying the project is the development of NeoMori, a fast-paced stealth platf
2929

3030
## Installation <a name="installation"/>
3131

32-
1. Navigate to the [**Releases**](https://github.com/Praqma/GodotDevOps/releases) page
32+
1. Navigate to the GitHub [**Releases**](https://github.com/Praqma/GodotDevOps/releases) page or the [**itch.io**](https://eficode.itch.io/neomori) page
3333
2. Download the latest release for your distribution
3434
3. Unzip the release to a chosen directory
3535
4. Follow instructions below for your distribution
3636

3737
### Windows
3838

39-
5. Rename the *`NeoMori`* file (not ~~*`NeoMori.pck`*~~) to *`NeoMori.exe`*
40-
- *This will be fixed in the future!*
41-
6. Run *`NeoMori.exe`* and enjoy!
39+
5. Run *`NeoMori.exe`* and enjoy!
4240

4341
### Linux
4442

@@ -95,7 +93,7 @@ For convenience's sake we allow "epics" to reside here as well. These are large
9593
9694
In Progress are issues currently being worked on.
9795
98-
As a rule of thumb, the amount of issues here shouldn't surpass the amount of project members at any given time.
96+
As a rule of thumb, the amount of issues here shouldn't surpass the amount of project members at any given time.
9997
Essentially, a developer can't work on two things at once.
10098
10199
It is perfectly fine to move issues back and forth between `To Do` and `In Progress`.
@@ -104,7 +102,7 @@ If an issue is larger than expected it can be broken down into smaller issues an
104102
105103
When an issue has all its _definition of done_ marks checked, it can be merged in, closed and moved to `Done`.
106104
107-
#### Done
105+
#### Done
108106
109107
Issues in `Done` are done and stay done.
110108
@@ -129,7 +127,7 @@ The `publish` workflow is triggered on tag.
129127
130128
It takes the built clients from the `build` workflow and publishes them as a GitHub Release.
131129
132-
### Creating a release <a name="releasing"/>
130+
### Creating a release <a name="creating-a-release"/>
133131
134132
1. Check out the commit you wish to release
135133
- *Only works if the commit has a successful build on main*

0 commit comments

Comments
 (0)
Please sign in to comment.