Skip to content

Commit c5ad309

Browse files
author
Francisco Javier Trujillo Mata
committed
Add CI status to readme and update readme format
1 parent a548af9 commit c5ad309

File tree

2 files changed

+55
-57
lines changed

2 files changed

+55
-57
lines changed

README

Lines changed: 0 additions & 57 deletions
This file was deleted.

README.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# ps2stuff
2+
3+
![CI](https://github.com/ps2dev/ps2stuff/workflows/CI/badge.svg)
4+
5+
```
6+
Copyright (C) 2000,2001,2002 Sony Computer Entertainment America
7+
8+
This file is subject to the terms and conditions of the GNU Lesser General Public License Version 2.1. See the file "COPYING" in the main directory of this archive for more details.
9+
```
10+
11+
12+
## Contact
13+
Tyler Daniel - [email protected]
14+
15+
16+
## General/About
17+
`ps2stuff` is, as the name implies, a collection of stuff that I have
18+
found useful for ps2 development. `ps2stuff` is most notably used by `ps2gl`,
19+
which generally motivates new releases.
20+
21+
22+
## Documentation
23+
24+
Hmm... I should probably write some. The header files are all the
25+
documentation that exists now...
26+
27+
## Compiling
28+
29+
`ps2stuff` uses the UberMakefile, developed here at SCEA R&D. There is
30+
some documentation at the top of the Makefile, but here is a
31+
quickstart:
32+
33+
You'll usually do 'make [buildname] [target]' where buildname is one
34+
of the build names listed in Makefile.builds and target is usually
35+
`clean` or nothing. If no build is given then the environment
36+
variable BUILDNAME is used, if that is not defined then the
37+
DEFAULTBUILD specified in the Makefile is used. So `make` will build
38+
the default build given in the Makefile, `make linux` will build a
39+
linux build, and `make optimized` will build a native (non-linux) build.
40+
41+
## Conventions
42+
43+
If you're modifiying existing code, follow the conventions for that module,
44+
otherwise use standard conventions.
45+
46+
Here are the conventions I use: local stuff starts with lowercase, non-local
47+
with uppercase and an optional lowercase prefix, "someVar" not "some_var,"
48+
constants start with `k`, macros start with `m`, classes start with `C`.
49+
50+
Please don't use the c preprocessor unless absolutely necessary; inlines instead
51+
of macros, and `static const float SomeVariable = 1.0f` not `#define
52+
SOME_VARIABLE 1.0f`. There is no memory or speed disadvantage to either of
53+
the above.
54+
55+

0 commit comments

Comments
 (0)