summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md36
1 files changed, 10 insertions, 26 deletions
diff --git a/README.md b/README.md
index 78663d2..effde5f 100644
--- a/README.md
+++ b/README.md
@@ -6,35 +6,19 @@ Simple step-by-step text and image-based tutorials for creating websites, email
Suggestions welcome.
+This site is compiled and organized with Hugo, using [this very simple theme](https://github.com/lukesmithxyz/lugo).
+
## Submission guidelines
-- follow the general style of pre-existing articles
+- Follow the general style of pre-existing articles.
- use the root user (i.e. no `sudo`) unless there is a specific need.
- do not preface commands with `$` or `#` or anything.
-- use `.svg` files for icons/logos and for illustrative images, keep filesize low
-- Use `example.org`
-- custom command/file info should be highlighted with `<strong>` tags
-
-### On `<pre>` tags
-
-
-In-line code should be in `<code>` tags, while codeblocks should be in a `<code>` tag *inside* of a `<pre>` tag.
-`<pre>` allows formatting preserving whitespace.
-That said, do *not* format `<pre>` tags as following:
-
-```
-<pre><code>
- echo "Here is a command."
- echo "Here is another."
-</code></pre>
-```
-
-but do it like this:
+- use `.svg` files for icons/logos and for illustrative images favor webp, keep filesize low.
+- Use `example.org` the example domain.
+- Do not add Docker tutorials.
+- Installable services must have the `service` tag and an `icon` set in the metadata so they properly appear in the service display.
+- Server/sysadmin tips should have the `server` tag, so they appear in that list.
-```
-<pre><code>echo "Here is a command."
-echo "Here is another."</code></pre>
-```
+## License
-**All** whitespace, including tabbing in and initial and final newlines are displayed by `<pre>`.
-To maintain consistency and avoid goofy-looking extra lines, add no extra whitespace.
+Adding anything to this site puts it in the public domain. You are welcome to add your personal links to the bottom of pages you write for credit.