• R/O
  • SSH

dwaddle: Commit

Main Dwaddle repository


Commit MetaInfo

Revision087a450793090228a4d9be87263879219f852587 (tree)
Time2021-05-12 15:58:07
AuthorRemilia Scarlet <remilia@post...>
CommiterRemilia Scarlet

Log Message

Update readme

Change Summary

Incremental Difference

diff -r 125da58bbcac -r 087a45079309 README.md
--- a/README.md Wed May 12 05:34:31 2021 +0000
+++ b/README.md Wed May 12 00:58:07 2021 -0600
@@ -1,29 +1,36 @@
11 # Dwaddle
22
3-Dwaddle is both a library and command line program for manipulating Doom WAD files (and a few other things).
3+Dwaddle is a library for manipulating Doom WAD and PK3 files (and a few other things).
44
55 The library focuses primarily on stricter compliance to standards, with a secondary focus of not being too slow.
66 It's meant to offer support for most mapping- and wad-related data structures through classes.
77
8-The command line programs aren't quite like most other WAD editors. Instead, it focuses on features that I didn't
9-find in other editors, yet realized I still needed.
10-
118 This is a rewrite from my old prototype code that was in Common Lisp.
129
1310 ## How do I get set up?
14-Clone this repository, then run `make release=1` (or just `make`). The binaries
15-will be in the `bin/` folder.
11+
12+ clone this repository manually using Mercurial.
1613
1714 ## Usage
1815
19-All of the binaries offer help through the `--help` argument.
16+Dwaddle is hosted in a Mercurial repository. Until the Shards command supports Mercurial (see [this
17+PR](https://github.com/crystal-lang/shards/pull/458)), you will need to first clone Dwaddle manually.
18+
19+After this, add something akin to this in your shard.yml file:
20+
21+```yaml
22+dependencies:
23+ dwaddle:
24+ # hg: https://hg.osdn.net/view/dwaddle/dwaddle # For future Mercurial support
25+ path: ../dwaddle/
26+```
27+
28+Once Mercurial support is in Shards, you'll be able to remove the `path:` line and uncomment the `hg:` line.
2029
2130 ## Development
2231
23-Dwaddle's API documentation is [here](https://nanako.mooo.com/dwaddle/doc/ckout/doc/api/index.html). If
24-documentation is missing, please feel free to add it.
32+### Style info
2533
26-### Style info
2734 I use a slightly different style for my code.
2835
2936 - Keep lines 118 characters or shorter. Obviously sometimes you can't, but please try. Use 115 characters for
@@ -37,9 +44,10 @@
3744 I do not use Git - **if you're reading this on Gitlab, you're looking at a mirror**. Let the Crystal folks know
3845 you'd like them to support other VCSs.
3946
40-1. Go to https://nanako.mooo.com/dwaddle and clone the Fossil repository.
47+1. Go to https://osdn.net/projects/dwaddle/scm/hg/dwaddle/ and clone the Mercurial repository.
4148 2. Create a new branch for your feature.
4249 3. Push locally to the new branch
50+4. Create a pull request on OSDN.
4351
4452 ## Contributors
4553
Show on old repository browser