commit 88656994c907d224d596f8ceee63105fbc54000a
parent 1be2b70d97c920ff9198915ca92994576ffb0c23
Author: vx-clutch <[email protected]>
Date: Sun, 24 Aug 2025 18:35:58 -0400
add style doc
Diffstat:
13 files changed, 71 insertions(+), 19 deletions(-)
diff --git a/doc/IDEA b/doc/IDEA
@@ -1,8 +0,0 @@
-./yait .
-Creating files 12, done.
-Changing permissions 2, done.
-Pulling ncurses, done.
-Pulling ux, done.
-Initializing git repository, done.
-Created yait at
- /home/vx-clutch/projects/yait
diff --git a/doc/sample_project/Makefile b/doc/sample_project/Makefile
diff --git a/doc/sample_project/README b/doc/sample_project/README
diff --git a/doc/sample_project/bin/bin b/doc/sample_project/bin/bin
diff --git a/doc/sample_project/configure b/doc/sample_project/configure
diff --git a/doc/sample_project/doc/information b/doc/sample_project/doc/information
diff --git a/doc/sample_project/include/project.h b/doc/sample_project/include/project.h
diff --git a/doc/sample_project/man/project.1 b/doc/sample_project/man/project.1
diff --git a/doc/sample_project/src/main.c b/doc/sample_project/src/main.c
diff --git a/doc/simple_project/Makefile b/doc/simple_project/Makefile
@@ -1,8 +0,0 @@
-.POSIX:
-CC ::= gcc
-CFLAGS ::= -Wall -Wpedenatic -O2
-
-all: simple
-
-clean:
- $(RM) simple
diff --git a/doc/simple_project/README b/doc/simple_project/README
@@ -1,3 +0,0 @@
-simple.c vx-clutch
-
-A simple program that does simple things.
diff --git a/doc/simple_project/simple.c b/doc/simple_project/simple.c
diff --git a/doc/styles b/doc/styles
@@ -0,0 +1,71 @@
+ Yb dP db 88 888888
+ YbdP dPYb 88 88
+ 8P dP__Yb 88 88
+ dP dP""""Yb 88 88
+
+ yait manual
+
+styles
+######
+
+In yait there are a few pre-made styles you can choose from. Those styles being
+the following.
+ * posix (default)
+ * gnu
+ * simple
+ * lib
+ * fasm
+These can be selected through setting the --style=<STYLE> flag.
+
+The POSIX style is the default style of yait and is the format used for the
+project. The POSIX style is structured as the following:
+ project/
+ bin/
+ build/
+ doc/
+ include/
+ project.h
+ man/
+ project.1
+ src/
+ main.c
+ COPYING
+ Makefile
+ README
+
+The GNU style is based on the GNU project layout guide; however, it is minified.
+ project/
+ man/
+ project.1
+ src/
+ main.c
+ AUTHORS
+ COPYING
+ INSTALL
+ NEWS
+ README
+ configure.ac
+
+The Simple style is a minimal layout for short and sweet projects.
+ project/
+ project.c
+ Makefile
+ README
+
+The Lib style is a layout for created libraries that compile to a .a and .so file.
+ project/
+ include/
+ project.h
+ src/
+ project.c
+ Makefile
+ README
+
+The Fasm style is a layout based on the flat assembler.
+ project/
+ SOURCE/
+ main.c
+ TOOLS/
+ build.sh
+ PROJECT.TXT
+
