Menu
▾
▴
[Performous-commit] Tapio Vierros : Docs updates.
|
From: Tapio V. <aa...@us...> - 2010-09-14 21:34:46
|
Module: performous Branch: master Commit: cb4a4cf7e14fc075b8118ff42bbf183771c27eab Author: Tapio Vierros <tap...@gm...> Date: Wed Sep 15 00:23:35 2010 +0300 Docs updates. --- docs/Authors.txt | 20 ++++++++++++++------ docs/Compiling.txt | 6 +++++- docs/DeveloperReadme.txt | 23 +++++++++++++++++------ docs/TODO.txt | 2 -- 4 files changed, 36 insertions(+), 15 deletions(-) diff --git a/docs/Authors.txt b/docs/Authors.txt index 7876be1..06d6f8b 100644 --- a/docs/Authors.txt +++ b/docs/Authors.txt @@ -9,6 +9,10 @@ Lasse Kärkkäinen <tronic+ndrm at trn.iki.fi> * Core developer * FFT/Analyzer, LibDA and a lot of other things +Tapio Vierros <aave000 at users.sourceforge.net> + * Core developer + * Lots of stuff in various areas + Topnob <topnob at users.sourceforge.net> * Non-power-of-two texture loading on older hardware * Many other fixes @@ -30,9 +34,6 @@ dex7 <dex7 at users.sourceforge.net> Fabian Fingerle <fabian at datensalat.eu> * Dependency testing -Tapio Vierros <aave000 at users.sourceforge.net> - * Various things and features - Miguel Sánchez de León Peque <msdeleonpeque at gmail.com> * Main menu * SVG design @@ -41,14 +42,21 @@ Xaldyz <xaldyz at users.sourceforge.net> * Windows build fixes and testing Markus Raab <ich at markus-raab.org> - * hiscore (xml + ultrastar format) + * Hiscore (xml + ultrastar format) Matti Kemppainen <mpkemppa at users.sf.net> - * prototyping dance game + * Prototyping dance game Jaakko Nikkola <jnikkola at users.sourceforge.net> * Dance game developer - + +John Stumpo <stump at jstump.com> + * Windows compilation scripts + +Fredrik Klasson <scientica at gmail.com> + * Logging stuff, xml i18n, image loading tweaks + + INACTIVE DEVELOPERS ------------------- diff --git a/docs/Compiling.txt b/docs/Compiling.txt index 62237c9..19cecdc 100644 --- a/docs/Compiling.txt +++ b/docs/Compiling.txt @@ -17,11 +17,13 @@ To install from git: Dependencies: + - OpenGL : graphics + - Boost : threads, parsers/conversions, pointer containers, ... - SDL : window management and input - - FFMpeg (avcodec, avformat and swscale): A/V decoding + - FFmpeg (avcodec, avformat and swscale): A/V decoding - Cairo >= 1.2 : scalable graphical support @@ -31,6 +33,8 @@ Dependencies: - PortAudio v19 : audio capture and playback + - Gettext (optional) for internationalization + - PortMidi (optional) for MIDI drum support - OpenCV (optional) for webcam support diff --git a/docs/DeveloperReadme.txt b/docs/DeveloperReadme.txt index 6ebe040..3ce9f6e 100644 --- a/docs/DeveloperReadme.txt +++ b/docs/DeveloperReadme.txt @@ -1,8 +1,22 @@ +NOTICE +====== +**Developer guides are now located at the wiki: http://wiki.performous.org/index.php/Developing** + +**This file is out dated.** + Where to find the files you are looking for: -share/ icons and other such binary files -themes/ all graphics, menu music, etc -game/ the source code of the game + docs/ documentation and man pages + data/ sounds and other such binaries + configuration files + themes/ all graphics, menu music, etc + game/ the source code of the game + tools/ various tools and scripts for both end-users and developers + lang/ translations + osx-utils/ OSX packaging tools + win32/ Windows specific stuff and packaging utilities + editor/ defunct song editor + portage-overlay/ ebuilds for Gentoo + cmake/ CMake modules When adding new data files, you may need to edit the CMakeLists.txt file in that folder to have CMake actually install it. When adding new source code files, @@ -166,6 +180,3 @@ there are no specifications to follow (you only find out what you will be doing after implementing some of it). Writing useful tests for code dealing with graphics, threads etc. is also very difficult. - -TODO: move the documentation in this file to the website developers page? - diff --git a/docs/TODO.txt b/docs/TODO.txt index 3c51138..2eb7331 100644 --- a/docs/TODO.txt +++ b/docs/TODO.txt @@ -26,10 +26,8 @@ Features: * Audio roundtrip by analyzing the sound captured by the microphone * Controller/audio latency by playing blindly (listening to the beat only) * Audio/video by playing visually without audio? (needs controller/audio calibrated) -- Better audio card configuration ingame (needs PortAudio backend) - Allow playing a single song given as commandline argument (no menus) - Kiosk/arcade mode (disable exiting game and limit other functions) -- Allow left-handed/reversed controllers (guitars, drum kits) Dance features: |
