summaryrefslogtreecommitdiff
path: root/README.md
AgeCommit message (Collapse)Author
2016-06-29Reword cloning stepsAustin
Users that skim thru the readme will just copy paste the first commands they see without reading, they shouldn't be hosted a clone, but should still be catered to in some case. This is just simply flipping the commands around.
2016-06-28Explains how to compile submodulesileyd
2016-06-27Fix cloning instructions (again..)Austin
caused by commit 7ea276bbdf881905c1e2ad42ea0501de623da223 in PR #38 author being ileyd
2016-06-27Improved MySQL to SQLite migration instructions (#38)ileyd
The initial paragraph explaining why you may prefer to use SQLite was made more brief, and rephrased to sound more neutral (note that it already was neutral). The clarifying section prior to the actual migration instructions was rewritten to better convey that the changes are non-destructive, and that they do not affect the user's main site until the final command (whose purpose is made clear), after verifying there are no issues. The instructions themselves have been modified to clarify where some commands are run from, their purpose, and also made more brief (the section itself is very slightly longer, but something happened to or I forgot to commit an important paragraph that was initially there).
2016-06-26Update README.mdAustin
2016-06-26Reword SQLite migrationAustin
That was bad
2016-06-22Added instructions and schema to use or migrate to SQLite (#17)akpu1
* Added MySQL to SQLite migration instructions; SQLite setup instructions * Renamed schema.sql to mysql_schema.sql * Produced modified schema suitable for SQLite * Added SQLite setup and migration instructions
2016-06-22Significant Makefile improvements (#21)akpu1
* Refactored makefile Fixed min-js error; renamed routines inline with make conventions Previously min-js would continually append to the file with `@echo "// @source https://github.com/pomf/pomf/tree/master/static/js" >> ./dist/pomf.min.js`. Fixed so that it overwrites the file whenever it is run now. mkdirs was renamed to installdirs as per makefile conwentions copy was renamed to install for the same reasons Added clean rule Removed install from default target Added DESTDIR,uninstall support Added dist support Replaced static program paths; misc improvements Added missing installdirs target to default target Added npm_dependencies target Properly separated "build" and install targets Modified readme to reflect make install and DESTDIR Modified .travis.yml to reflect make npm_dependencies Reverted to cp for install target, temporarily Ideally this target would use install, but need to work out how to do that properly, For the meantime, cp works. Added missing * to install target Update .travis.yml Fixed bad markdown * Update Makefile * Removed @s cuz ???
2016-06-19Introduce configuration examplesEliot Whalan
2016-06-19Correct license url in readme.mdEliot Whalan
2016-06-18Fix up nginx config formatting in READMEEliot Whalan
2016-06-18Add depends tracking and mit license badgeEliot Whalan
2016-06-18Add example nginx config filesEliot Whalan
2016-06-18Remove all mentions of grunt from READMEEliot Whalan
2016-06-18Remove grunt from readmeEliot Whalan
2016-06-18Updated readme to clarify front and back end settingsakpu1
2016-06-17Add Travis-ci and depends trackingEliot Whalan
2016-06-16Update urls readme and package.jsonEliot Whalan
2016-05-08README: Add #pomf on Partyvan to getting helpJuuso Lapinlampi
It turns out that moving to Rizon's IRC network was a bad idea after all. One or more developers (myself included) are unable to connect to Rizon for using Tor or operating Tor exits. Now there's this split: Users and Pomf site maintainers are on #pomfret on Rizon (where I don't have frequent access) and development has moved back to #pomf on Partyvan (where there's also #/g/hostingtalk). Given how I personally play such a big role in leading Pomf development, it has no longer been practical to continue development communication on an IRC network I can't access. There was no interest to finish setting up a mailing list for Pomf development because IRC was considered more important. Thus, the stagnation and stalled development of pantsu/pomf between 2016-01-31 and 2016-04-30 as seen in commit logs. There used to be an IRC channel called #pantsucat on Partyvan's IRC network, before development moved to Rizon. That channel is no longer active. See: pantsu/pomf@5846ba7ccb1aa6af2850b3fcf34c6bd396995161 Reviewed-by: Eliot Whalan <ewhal@pantsu.cat>
2015-12-27Fix README.md contributing grammar: by email -> via emailJuuso Lapinlampi
2015-12-27Clarify we don't use any Git service issue trackingJuuso Lapinlampi
Reword the "no Git issue tracking" policy in contributing section. Previously the contributing section in README.md would say we don't use git.pantsu.cat's issue tracker to track issues. That Git service repository's issues have been disabled today, so we might as well say we don't use any Git service issue tracking. Unofficial mirrors like the one on notabug.org may still have issue tracking, which I believe we have no control over. This commit also clarifies that we do it for ethical and technical objections. (In short, it's because the Git service is centralized and a walled garden.) For more information, see wubthecaptain/deathwatch-pomf@fc86cbf for information why.
2015-10-22Contributing: Move IRC channel to #pomfret on RizonJuuso Lapinlampi
Me and antonizoon have decided to create a new central channel for Pomf.se clone discussion. This leaves #/g/hostingtalk dedicated to its intended purpose, general server hosting discussion. The channel name #pomfret comes from ArchiveTeam's EFnet channel of the same name, which was used to rescue Pomf.se's files. The channel on EFnet is without OPs these days. antonizoon also suggested lots of imageboard/chan channels are also on Rizon, so Rizon was chosen for the channel as a good fit. Rizon also houses the #bibanon channel, which is the official channel for Bibliotheca Anonoma. OK ewhal@
2015-10-18Add "Demo" subheading under "Features" in README.mdJuuso Lapinlampi
The link to real world example at Pantsu.cat is not semantically a feature, but its own demonstration. Adding a subheader for the example increases semantics further, and makes it easier to find.
2015-10-18Add "Features" section to README.mdJuuso Lapinlampi
The README.md lacks a features section, which is worthful for those searching for a suitable file sharing platform to host. This change lists the features and seperates "Requirements" to its own section. Worthy read: "How to Write a Readme Worth Reading" by Diana Thayer. https://orchestrate.io/blog/2014/07/16/how-to-write-a-readme-worth-reading/
2015-10-10Fix README.md grammarJuuso Lapinlampi
Thanks to alchimist@ for doing editorial review.
2015-10-09Rewrite "Configuring" section to be more confidentJuuso Lapinlampi
The previous example can create a feeling of worry in the mind of the reader. This will aim to fix that.
2015-10-09Clarify IRC usage for contribution merge requestsJuuso Lapinlampi
We use IRC for code review, so naturally merge requests also happen there.
2015-10-09Linkify git.pantsu.cat in README.mdJuuso Lapinlampi
2015-10-09Add "Contributing" section to README.mdJuuso Lapinlampi
Worthy read: "Top ten reasons why I won’t use your open source project" by Adam Stacoviak. https://changelog.com/top-ten-reasons-why-i-wont-use-your-open-source-project/
2015-10-09Replace Pomf.se HTTPS link to HTTP in README.mdJuuso Lapinlampi
It seems neku doesn't have a working HTTPS website anymore. It certainly used to.
2015-10-09Add "Credits" section to README.mdJuuso Lapinlampi
2015-10-09Replace "Contact" section with "Getting help"Juuso Lapinlampi
This also adds a mention of the IRC channel. Worthy read: "Readme Driven Development" by Tom Preston-Werner: http://tom.preston-werner.com/2010/08/23/readme-driven-development.html
2015-09-27Fix README.md grammar "e.g.,"Juuso Lapinlampi
A punctuation mark always precedes e.g. In American English a comma should follow e.g. The list of examples following e.g. should not be exhaustive. Reference: https://en.wiktionary.org/wiki/e.g.
2015-09-27Change README.md example domain to a.pomf.exampleJuuso Lapinlampi
.example is a reserved domain name intended to be used for documentation, defined in RFC 2606. The purpose is to reduce the likelihood of conflict and confusion. OK ewhal@
2015-09-27Add Markdown inline code blocks to README.md site/PHPJuuso Lapinlampi
Ciro Santilli's Markdown Style Guide advises to mark these as code.
2015-09-27Fix README.md grammar "an attacker"Juuso Lapinlampi
English nouns begin with an indefinite article "a" or "an". Usually "a" is used when the word that follows starts with a consontant, and "an" is used when the word that follows starts with a vowel. The word "attacker" starts with a vowel and has no different pronunciation of the first letter, so the correct indefinite article to use is "an". The correct way to pronounce it is "an attacker". This fixes an error introduced in commit db66648.
2015-09-24Replace ambiguous MIT license mentions with ExpatJuuso Lapinlampi
MIT has used many licenses for software. Calling this project to be available under a "MIT" license is misleading.
2015-09-23Replace markdown backticks with four space indentsJuuso Lapinlampi
Fenced code blocks are not part of the original markdown standard, thus less portable. Even if fenced code blocks were used, they should specify the code language with it. Indented code blocks with 4 spaces are portable, which we prefer.
2015-09-23Removed Todo sectionHarry H
2015-09-20Change README.md contact email to a mailto: linkWubTheCaptain
2015-09-19Change Git URL to self-hosted pantsu/pomf.gitWubTheCaptain
2015-09-19Remove moe panel from corepantsucat
The moe panel is more of an extension of the core, but not necessary for Pomf's functionality. The code also suffers from bad practices and it's more of a prototype. The panel is also mostly unmaintained by its author. This code will be in a seperate Git repository called pomf-moe from now on.
2015-09-19Replace github urls with self-hosted Gitpantsucat
2015-09-19Fix README.md outlineWubTheCaptain
2015-09-15Fix build instruction folder path to lowercasepantsucat
2015-09-15Change clone url to git://pantsucat
2015-09-15Change README.md repository URLpantsucat
2015-09-15Change contact address to hostmaster@pantsu.catpantsucat
2015-09-15Full git history nowpantsucat
2015-06-20Update README.mdEric Johansson (neku)