Update CONTRIBUTING.md and README.md to indicate that this is a fork
This commit is contained in:
35
README.md
35
README.md
@@ -1,30 +1,10 @@
|
||||
|
||||
<p align="center">
|
||||
<a href="https://writefreely.org"><img src="https://writefreely.org/writefreely.svg" width="350px" alt="Write Freely" /></a>
|
||||
</p>
|
||||
<hr />
|
||||
<p align="center">
|
||||
<a href="https://github.com/writeas/writefreely/releases/">
|
||||
<img src="https://img.shields.io/github/release/writeas/writefreely.svg" alt="Latest release" />
|
||||
</a>
|
||||
<a href="https://goreportcard.com/report/github.com/writeas/writefreely">
|
||||
<img src="https://goreportcard.com/badge/github.com/writeas/writefreely" alt="Go Report Card" />
|
||||
</a>
|
||||
<a href="https://travis-ci.org/writeas/writefreely">
|
||||
<img src="https://travis-ci.org/writeas/writefreely.svg" alt="Build status" />
|
||||
</a>
|
||||
</p>
|
||||
|
||||
# WriteFreely (lupine's fork)
|
||||
|
||||
WriteFreely is a beautifully pared-down blogging platform that's simple on the surface, yet powerful underneath.
|
||||
|
||||
It's designed to be flexible and share your writing widely, so it's built around plain text and can publish to the _fediverse_ via ActivityPub. It's easy to install and lightweight.
|
||||
|
||||
**[Start a blog on our instance](https://write.as/new/blog/federated)**
|
||||
|
||||
[Try the editor](https://write.as/new)
|
||||
|
||||
[Find another instance](https://writefreely.org/instances)
|
||||
See [CONTRIBUTING.md](contributing.md) for more information on why it's forked
|
||||
|
||||
## Features
|
||||
|
||||
@@ -38,16 +18,17 @@ It's designed to be flexible and share your writing widely, so it's built around
|
||||
|
||||
> **Note** this is currently alpha software. We're quickly moving out of this v0.x stage, but while we're in it, there are no guarantees that this is ready for production use.
|
||||
|
||||
First, download the [latest release](https://github.com/writeas/writefreely/releases/latest) for your OS. It includes everything you need to start your blog.
|
||||
First, build writefreely.
|
||||
|
||||
Now extract the files from the archive, change into the directory, and do the following steps:
|
||||
Now change into the directory, and do the following steps:
|
||||
|
||||
```bash
|
||||
# 1) Log into MySQL and run:
|
||||
# CREATE DATABASE writefreely;
|
||||
# 1) Start an SQLite3 database
|
||||
sqlite3 writefreely.sqlite3
|
||||
|
||||
#
|
||||
# 2) Import the schema with:
|
||||
mysql -u YOURUSERNAME -p writefreely < schema.sql
|
||||
.read schema.sql
|
||||
|
||||
# 3) Configure your blog
|
||||
./writefreely --config
|
||||
|
Reference in New Issue
Block a user