mia/Aegisub
1
0
Fork 1
Code Issues Pull requests Projects Releases Wiki Activity

Add the beginnings of a README file

Browse source
This commit is contained in:
Thomas Goyne 2013-04-21 15:49:30 -07:00
parent 90b35efa75
commit b2953e82cb
2 changed files with 48 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

48
README.md Normal file
View file

@ -0,0 +1,48 @@
# Aegisub
For binaries and general information [see the homepage](http://www.aegisub.org).
The bug tracker can be found at http://devel.aegisub.org.
Support is available on [the forums](http://forum.aegisub.org) or [on IRC](irc://irc.rizon.net/aegisub).
## Building Aegisub
### Windows
Prerequisites:
1. Visual Studio 2012. Express edition might work.
2. A recent Windows SDK
3. A recent DirectX SDK
4. A MSYS install with git and c99conv. Note that mingw is not required.
There are a few optional dependencies:
1. msgfmt, to build the translations
2. WinRAR, to build the portable installer
3. InnoSetup, to build the regular installer
All other dependencies are either stored in the repository or are included as submodules.
Building:
1. Clone Aegisub's repository recursively to fetch it and all submodules: `git clone --recursive git@github.com:Aegisub/Aegisub.git`
2. Disable autocrlf for ffmpeg, as its build system manages to not support Windows newlines: `cd aegisub/deps/ffmpeg && config --local core.autocrlf && git rm --cached -r . && git reset --hard`
3. Open Aegisub.sln
4. Build the "! Update Dependencies" project
5. Open the properties for the Aegisub project and set the location of MSYS in Configuration Properties > Aegisub > Library paths
6. Build Aegisub
7. Copy the contents of an existing Aegisub install into the aegisub/aegisub/bin directory (not strictly required, but you'll be missing a lot of functionality otherwise).
There's a pile of other files such as dictionaries, VSFilter and avisynth
For actual development work you will probably want to mostly use the
"Debug-MinDep" configuration (which disables building most of the projects), as
the dependency checking is pretty slow.
## License
All source files in this repository are licensed under either 3-clause BSD or
ISC licenses. In practice, Aegisub binaries are usually GPL licensed due to the
dependencies.

1
aegisub/README
View file

@ -1 +0,0 @@
* To be written.