aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.rst
diff options
context:
space:
mode:
authorThomas Voss <mail@thomasvoss.com> 2021-10-12 17:59:37 +0200
committerThomas Voss <mail@thomasvoss.com> 2021-10-12 17:59:37 +0200
commit11a2560513e114ae30904f0598c4732aeac1972a (patch)
tree15643f492e57cae1e5a9a858f2f13b3fa5633335 /README.rst
[Meta] Initial commit
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst23
1 files changed, 23 insertions, 0 deletions
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..8ed5334
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,23 @@
+.. vi: tw=100
+
+mpaste
+======
+
+**mpaste** is a super minimal paste server written in Go. It supports extremely simple file uploads
+assuming you have the tools available to do so, such as ``curl(1)``. It also supports viewing pastes
+in the browser as either raw text or with syntax highlighting. This paste server has no web
+interface for adding pastes, no stupid moving parts, no useless garbage.
+
+
+Documentation
+-------------
+
+Read `the manual`_
+
+.. _the manual: mpaste.1
+
+
+Compilation
+-----------
+
+Just run the ``make`` command.