aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorRichard Qin <richard.qin.x@gmail.com>2026-11-07 05:04:48 +0800
committerRichard Qin <richard.qin.x@gmail.com>2026-11-07 05:04:48 +0800
commit4db2479ffc9c257f36aeb3673d507d1b4302e682 (patch)
treee641deec2f5b0b706aed4048fd342b6e635affd4 /README
parentc46f1d1834c2ad2dc662a9499807aabe9992de82 (diff)
downloadrcc-project-4db2479ffc9c257f36aeb3673d507d1b4302e682.tar.gz
rcc-project-4db2479ffc9c257f36aeb3673d507d1b4302e682.tar.xz
[Doc] Move README to plain text
Signed-off-by: Richard Qin <richard.qin.x@gmail.com>
Diffstat (limited to 'README')
-rw-r--r--README38
1 files changed, 38 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..b889c2b
--- /dev/null
+++ b/README
@@ -0,0 +1,38 @@
+This directory contains the RCC Project.
+
+The RCC Project is a collection of systems software, from compilers to
+terminal applications.
+
+The RCC Project is free software, distributed under the GNU General Public
+License, version 3. See the file COPYING for the license terms.
+
+The RCC Project currently includes rcc, proofsearch, ricochet, raytracing,
+rv64cpu, muqemu, and other projects.
+
+rcc
+ A C compiler project, including a frontend, middle end, and backend.
+
+proofsearch
+ An automated theorem prover for first-order logic using
+ clause-saturation-based proof search.
+
+ricochet
+ A terminal-based web browser.
+
+raytracing
+ A ray tracer written in modern C++.
+
+rv64cpu
+ An RV64 RISC-V processor core written in SystemVerilog.
+
+muqemu
+ A simplified model of QEMU written in modern C++.
+
+Projects for binary utilities, memory allocators, and other systems software
+will be added to the repository as subprojects.
+
+Each subproject maintains its own build entry points, build dependencies,
+and runtime behavior.
+
+For specific build instructions, see the build files and documentation in
+the corresponding subproject directory.