Coding style and notice
This commit is contained in:
parent
b25e4282b5
commit
819c917292
26
README.md
26
README.md
|
@ -1,11 +1,8 @@
|
|||
# Quadrimino
|
||||
|
||||
Highly configurable, terminal modern Tetris clone written in C.
|
||||
|
||||
## Plan
|
||||
|
||||
### Configuration
|
||||
|
||||
Things that will be configurable:
|
||||
|
||||
* Gavity
|
||||
|
@ -35,7 +32,6 @@ Things that will be configurable:
|
|||
* Classic vs. Modern loosing
|
||||
|
||||
### UI elements
|
||||
|
||||
* Timer
|
||||
* Score counter
|
||||
* Zone counter
|
||||
|
@ -48,7 +44,6 @@ Things that will be configurable:
|
|||
* Matrix is a checkerboard of filled in squares (██)
|
||||
|
||||
### Multiplayer
|
||||
|
||||
Implimented last
|
||||
|
||||
If there is one opponent, it would probably be viewed in the same terminal window. If there are multiple opponents, you can cycle/select the opponent that you want to see.
|
||||
|
@ -63,9 +58,28 @@ If there is one opponent, it would probably be viewed in the same terminal windo
|
|||
### TODO
|
||||
[ ] Learn C<br>
|
||||
[ ] Learn Ncurses<br>
|
||||
[ ] Create more in depht plan
|
||||
[ ] Create more in-depht plan<br>
|
||||
[ ] Implement configuration file reading
|
||||
|
||||
## Dependencies
|
||||
* Make
|
||||
* Ncurses
|
||||
* C Compiler
|
||||
|
||||
## Style
|
||||
* Comment everything. Comments are critical to having readable code.
|
||||
* `/* */` intead of `//`
|
||||
|
||||
* Short variable names. Declarations are followed by comments. If you can't remember them, write them down.
|
||||
|
||||
* No more than one consecutive empty line. Extravigant spacing is pretty, but it is extremely hard to be consistant with spacing.
|
||||
* Coments should be right above the code the are explaining. Unless the code they are explaining has comments in it, in which case there should be a single empty line between the comment and the code.
|
||||
|
||||
* Max line length of 79
|
||||
|
||||
* What would Suckless do?
|
||||
* https://suckless.org/coding_style/
|
||||
* The coding style of this project closely reflects that of the suckless coding style
|
||||
|
||||
## Notice
|
||||
Please keep in mind that the devs of this project are new to programing.
|
||||
|
|
Loading…
Reference in New Issue