Skip to content

Commit

Permalink
v00.002 Read changelog.txt
Browse files Browse the repository at this point in the history
  • Loading branch information
frozenMustelid committed Dec 19, 2017
1 parent 843d521 commit fa50f2f
Show file tree
Hide file tree
Showing 20 changed files with 3,299 additions and 2,703 deletions.
37 changes: 37 additions & 0 deletions CONTRIBUTING
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
Should be pretty simple. Download. Read the CONTRIBUTOR AGREEMENT. Make changes.
Document changes. Add self to CONTRIBUTORS file, using any name you choose (or
be anonymous if you prefer). Send changed files back using whatever method you
prefer.

For some changes (like adding new games to PFSB's monster generator), you may
want to read the OGL too. A copy should have been included with the program, as
should the CONTRIBUTORS file. It shouldn't be necessary to update the OGL's
copyright notice.

Is is preferred that you try to match styles with the existing codebase. This
doesn't have to include profane rants or sophomoric jokes in the code comments,
but it can if you feel it's warranted. Matching styles includes keeping the
documentation cat-friendly.

Also preferred is testing your changes. See if it still builds, didn't include
too many regressions, the fix actually fixes what it's supposed to fix, etc.
Obviously pobody's nerfect, but a modicum of testing helps out immensely. Note:
If it doesn't build on my machine, AFAIC it doesn't build on anyone's machine
except maybe the submitter's.

That said: If you send me something better than what I have, I'll almost
certainly include it. Even a half-baked implementation is better than no
implementation, unless it somehow reduces functionality of working things.


ROADMAP
*SLAs and spells planned for 0.3
*GUI will probably show up before 1.0
*Save/load IP creatures expected to appear with GUI.
*Change to a PDF output will likely be near the 1.0 release. As long as the
output remains HTML-based, it is expected that the program may make
mistakes that the user will have to correct by manually editing the
HTML file.
*Move all OGL stuff to a seperate repo, which PFSB grabs as part of the
install/build process. Probably pre-1.0, maybe even before 0.10.
*Templates are complicated, almost definitely post-1.0
49 changes: 49 additions & 0 deletions CONTRIBUTOR AGREEMENT
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
DEFINITIONS:

1) "Code" - Source code, object code, machine code, or any documentation
relating to source code, object code, or machine code.

2) "You" - Any person or group that submits additions to the Code and/or
changes to the Code the PFSB project.

3) "Project Owner" - The current owner of the PFSB project, whoever that
may be at any time.

4) "Submit" - To attempt to incorporate Your Code, whether it is new Code
or changes to existing Code, into the PFSB project.

By Submitting Code via any method and adding Yourself to the CONTRIBUTORS text file, You understand and agree to the following:

*The Submitted Code's copyright belongs to You, or that You a) Have a legal
right to propagate the Submitted Code, b) The Submitted Code is
licensed to You in such a way that its inclusion in PFSB in any way
does not violate any terms PFSB is currently distributed under, and
c) The Submitted Code does not violate any part of this document.

*The Submitted Code's patents, if they exist, belong to You, or that You
a) Have a legal right to propagate the Submitted Code, b) The
Submitted Code is licensed to You in such a way that its inclusion in
PFSB in any way does not violate any terms PFSB is currently
distributed under, and c) The Submitted Code does not violate any part
of this document.

*You keep ownership of Your Submitted Code's copyright, if You possess it,
unless You explicitly grant it to the PFSB project.

*You grant the Project Owner a non-exclusive, perpetual, irrevocable,
worldwide, no-charge, royalty-free, transferrable copyright license to
use, distribute, propagate, modify, publicly display, publicly perform
and prepare derivative works from the Submitted Code for use in the
PFSB project with the license it is using at the time of Your
Submission. You also grant the Project Owner the right to relicense
Your Submitted Code under any software license that the Free Software
Foundation has declared to be a free software license. The Project
Owner may exercise this right without contacting or requesting
permission from You.

*Should the Submitted Code be patented, all patent licenses similar to
those listed above for copyright shall be granted to the Project
Owner.


This document was last updated for the release of PFSB v00.002.
29 changes: 29 additions & 0 deletions CONTRIBUTORS
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
This file follows the example of the Linux kernel's CREDITS file.
People who submit changes are expected to add themselves to this
file.

(N) is name.
(E) is email.
(W) is web address.
(D) is a brief description of the person's contribution.
"Contribution" can mean someone directly sent a pull request or
patch to me, or it can mean that I found a piece of license-
compatible code and decided to use it.
(S) is the date of acknowledgement and agreement to the
contributor agreement. Effectively an electronic signature.

If you wish to remain an anonymous contributor or otherwise not post
your N/E/W/D(s), write "Anonymous" or something similar in the appropriate
fields. If you don't write anything for (S), your change will be
rejected, so please don't forget to add yourself.

Above message last updated in v00.002.
Listings below last updated 2017-12-18.
--------------------------------------------------------------------------------
(N) Frozen Mustelid
(E) [email protected]
(W) N/A
(D) Project owner/maintainer, main program designer/programmer
(S) Unnecessary, project owner


18 changes: 9 additions & 9 deletions DEPENDENCIES.txt
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
1. A C++ compiler that supports C++14.
2. Better make sura that compiler is G++. There's no program logic tied to the
compiler or its extensions, but the Makefile won't work if it can't use G++
to compile.
3. A /usr/bin folder.
4. A /usr/share folder.
5. A web browser. Strictly speaking, the browser isn't necessary, but unless you
prefer reading raw HTML over a nicely CSS-styled HTML document, you'll want
one.
1. A C++ compiler that supports C++14.
2. Better make sure that compiler is G++. There's no program logic tied to the
compiler or its extensions, but the Makefile won't work if it can't use G++
to compile.
3. A /usr/bin folder.
4. A /usr/share folder.
5. A web browser. Strictly speaking, the browser isn't necessary, but unless you
prefer reading raw HTML over a nicely CSS-styled HTML document, you'll want
one.
44 changes: 28 additions & 16 deletions Known Issues.txt
Original file line number Diff line number Diff line change
@@ -1,16 +1,28 @@
Current:
*DR and SR not implemented due to oversight
*SLAs not implemented... Yet.
*Program does little user entry verification and is fragile as a result
*Only creature icon implemented is "construct"
*No icons for environment or climate
*No logic to pick an icon for environment or client
*Program, despite being written in standard C++14, only runs on *nix
*Program, despite being written in standard C++14, requires G++
*Program produces unrepresentable characters at the end of the file. I
suspect that this is an extra EOF character. xed renders this
as umlaut y when I set the html charset tage to utf-8, but
without that tag, xed instead renders '\FF'. Firefox renders
these as question mark diamonds.

Changed:
Current:
*No icons for environment or climate
*No logic to pick an icon for environment or client
*Only creature icon implemented is "construct"
*Program, despite being written in standard C++14, only runs on *nix
*Program, despite being written in standard C++14, requires G++
*Program does little user entry verification and is fragile as a result
*Program is not distributed as Free Software
*Program produces unrepresentable characters at the end of the file. I
suspect that this is an extra EOF character. xed renders this
as umlaut y when I set the HTML charset tag to utf-8, but
without that tag, xed instead renders '\FF'. Firefox renders
these as question mark diamonds.
*SLAs not implemented... Yet.
*XP value always has at least 1 extra space. However, this doesn't appear to
actually render.


Changed since last release:
+Program is not distributed as Free Software
+XP value always has at least 1 extra space. However, this doesn't appear to
actually render.

-DR and SR not implemented due to oversight
-The program will produce empty parentheses next to the the creature type if
there are no subtypes.

*Sorted list
52 changes: 37 additions & 15 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,26 +1,48 @@
bin/pfsb:
mkdir bin/
g++ -v -std=c++14 -o bin/pfsb src/pfsb.cpp
all:bin/pfsb

.PHONY: install clean uninstall
bin/pfsb: obj/pfMon.o obj/main.o
@mkdir -p bin/
g++ -v -ansi -std=c++14 -o bin/pfsb obj/main.o obj/pfMon.o

obj/pfMon.o:
@mkdir -p obj/
g++ -c -v -ansi -std=c++14 -o obj/pfMon.o src/pfMon.cpp

obj/main.o:
@mkdir -p obj/
g++ -c -v -ansi -std=c++14 -o obj/main.o src/main.cpp




.PHONY: install clean distclean uninstall total-uninstall
install:
mkdir -p /usr/share/pfsb/pfrpg/html
mkdir -p /usr/share/pfsb/pfrpg/images/environ /usr/share/pfsb/pfrpg/images/temp /usr/share/pfsb/pfrpg/images/type
@mkdir -p /usr/share/pfsb/pfrpg/html/

@mkdir -p /usr/share/pfsb/pfrpg/images/environ/
@mkdir -p /usr/share/pfsb/pfrpg/images/temp/
@mkdir -p /usr/share/pfsb/pfrpg/images/type/

cp html/pfrpg.html html/pfrpg.css -t /usr/share/pfsb/pfrpg/html/
-cp images/type/* /usr/share/pfsb/pfrpg/images/type
-cp images/temp/* /usr/share/pfsb/pfrpg/images/temp
-cp images/environ/* /usr/share/pfsb/pfrpg/images/environ
cp images/type/* /usr/share/pfsb/pfrpg/images/type/
# -cp images/temp/* /usr/share/pfsb/pfrpg/images/temp/
# -cp images/environ/* /usr/share/pfsb/pfrpg/images/environ/

cp bin/pfsb /usr/bin
cp bin/pfsb /usr/bin/

clean:
@rm -r bin/
@rm -rf bin/
@rm -rf obj/

distclean: clean



#CSS file left alone so that generated monsters still display correctly
uninstall:
rm /usr/bin/pfsb
rm -r /usr/share/pfsb/pfrpg/images
rm /usr/share/pfsb/pfrpg/html/pfrpg.html

@rm -f /usr/bin/pfsb
@rm -rf /usr/share/pfsb/pfrpg/images
@rm -f /usr/share/pfsb/pfrpg/html/pfrpg.html

total-uninstall: uninstall
@rm -rf /usr/share/pfsb/
Loading

0 comments on commit fa50f2f

Please sign in to comment.