aboutsummaryrefslogtreecommitdiffstats
path: root/docs/dergods_style_v0.1.ms
diff options
context:
space:
mode:
authorJozanLeClerc <bousset.rudy@gmail.com>2020-11-13 23:51:12 +0100
committerJozanLeClerc <bousset.rudy@gmail.com>2020-11-13 23:51:12 +0100
commit4b065dabcdd7150fb1504ca2895e48c018ba0a0b (patch)
tree0b6093ac647effa36eec32a7d9ef63f06a55e408 /docs/dergods_style_v0.1.ms
parenttroff norm translation in progress (diff)
downloadjoe-www-4b065dabcdd7150fb1504ca2895e48c018ba0a0b.tar.gz
joe-www-4b065dabcdd7150fb1504ca2895e48c018ba0a0b.tar.bz2
joe-www-4b065dabcdd7150fb1504ca2895e48c018ba0a0b.tar.xz
joe-www-4b065dabcdd7150fb1504ca2895e48c018ba0a0b.tar.zst
joe-www-4b065dabcdd7150fb1504ca2895e48c018ba0a0b.zip
Good progresses
Diffstat (limited to '')
-rw-r--r--docs/dergods_style_v0.1.ms130
1 files changed, 111 insertions, 19 deletions
diff --git a/docs/dergods_style_v0.1.ms b/docs/dergods_style_v0.1.ms
index 37d0217..fff2c0a 100644
--- a/docs/dergods_style_v0.1.ms
+++ b/docs/dergods_style_v0.1.ms
@@ -1,9 +1,6 @@
-.nr PS 12p
-.nr PO 1.0i
-.nr LL 6.5i
.defcolor blue rgb 0.1f 0.1f 1.0f
-.defcolor bsdred rgb #9d2121
-.defcolor codered rgb #900000
+.defcolor bsdred rgb #990000
+.defcolor codered rgb #600000
.defcolor grey rgb #aaaaaa
.defcolor black rgb #000000
.color
@@ -21,13 +18,38 @@
.de b
.B "\m[bsdred]\\$1\m[]" \\$2 \\$3
..
-.de nh
+.de code
+.gcolor bsdred
+.CW \\$1 \\$2 \\$3
+.gcolor
+..
+.de nh1
.gcolor bsdred
-.NH \\$1
+.NH 1
.ps 14p
-\\$2
+\\$1
.gcolor
..
+.de nh2
+.gcolor bsdred
+.NH 2
+.ps 13p
+\\$1
+.gcolor
+..
+.de bu
+.IP \(bu 2
+..
+.
+.
+.
+.
+.nr PS 12p
+.nr PO 1.0i
+.nr LL 6.5i
+.RP no
+.P1
+.ND
.
.
.
@@ -42,22 +64,22 @@ Dergods' Style and good practices for C/C++ projects
.AU
.ps 15p
Joe
-
-.ps 12p
-v0.1
-.DA
-
-
+.AI
+42 Lyon Auvergne-Rhône-Alpes
+.
+.
.XS 1
.ps 12p
.b "1. Introduction"
.xa 1 "2. Projects and version control"
.xa 1 " 2.1 Directories"
.XE
+.bsdr
.PX
-
-
-.nh 1 "Introduction"
+.endc
+.
+.
+.nh1 "Introduction"
.PP
The following is a description of
.b "Dergods' Style"
@@ -73,5 +95,75 @@ manpath=FreeBSD+12.1-RELEASE+and+Ports&arch=default&format=html \
\f(CW\m[codered]style(9)\m[]\f[]
.gcolor
with some changes.
-.nh 1 "Projects and version control"
-.nh 2 "Directories"
+.nh1 "Projects and version control"
+.nh2 "Directories"
+.RS
+.bu
+Working on a
+.b program :
+.RS
+.bu
+All
+.b source
+and
+.b "header files"
+should be in the
+.code src/
+directory.
+.bu
+Necessary
+.b "media files"
+such as images, sounds, fonts, etc... Necessary to the program execution
+should be in the
+.code media/
+directory.
+.bu
+Compilation-generated
+.b "object files"
+should be located in the
+.code obj/
+directory.
+.bu
+.b Sub-programs
+or
+.b utilities
+should be located in the
+.code utils/
+directory.
+.bu
+Optional
+.b "man page(s)"
+can be made for the project and its specularities and should be located in the
+.code man/
+directory.
+.RE
+.bu
+Working on a
+.b library :
+.RS
+.bu
+All
+.b "source files"
+should be located in the
+.code src/
+directory.
+.bu
+Compilation-generated
+.b "object files"
+should be located in the
+.code obj/
+directory.
+.bu
+Non-optional
+.b "man pages"
+for every function intended to be used externally
+should be located in the
+.code man/
+directory.
+.bu
+.b "Header files"
+should be located in the
+.code include/
+directory.
+.RE
+.RE