Update docs

This commit is contained in:
Alexander Kojevnikov 2012-08-30 12:36:15 -07:00
parent fe52dd068a
commit 8b91d79492
7 changed files with 59 additions and 60 deletions

24
AUTHORS
View File

@ -1,24 +0,0 @@
Maintainer:
Alexander Kojevnikov <alexander@kojevnikov.com>
Contributors:
Fabian Deutsch
Jonathan Gonzalez V
Stefan Kost
Thibault North
Translators:
Florent Thoumie
Giuseppe D. Barbagallo
Huang Shibing
Jonathan Gonzalez V
Olga Vasylevska
Pavel Fric
Philipp Defner
Piotr Drąg
Ryan Smith
Tiago Rinaldi
Wouter Bolsterlee
Artist:
Olga Vasylevska

28
AUTHORS.md Normal file
View File

@ -0,0 +1,28 @@
Maintainer:
* Alexander Kojevnikov (<alexander@kojevnikov.com>)
Contributors:
* Fabian Deutsch
* Jonathan Gonzalez V
* Stefan Kost
* Thibault North
Translators:
* Florent Thoumie
* Giuseppe D. Barbagallo
* Huang Shibing
* Jonathan Gonzalez V
* Olga Vasylevska
* Pavel Fric
* Philipp Defner
* Piotr Drąg
* Ryan Smith
* Tiago Rinaldi
* Wouter Bolsterlee
Artist:
* Olga Vasylevska

View File

@ -33,8 +33,8 @@ Spek requires OS X 10.5+ and an Intel-based Mac.
To build Spek, download the source code tarball then run these commands from To build Spek, download the source code tarball then run these commands from
terminal, adjusting the path to wx-config as necessary: terminal, adjusting the path to wx-config as necessary:
tar -xJvf spek-0.x.tar.xz tar -xJvf spek-0.8.0.tar.xz
cd spek-0.x cd spek-0.8.0
./configure --with-wx-config=/path/to/wx-config ./configure --with-wx-config=/path/to/wx-config
make make

View File

@ -7,6 +7,7 @@ SUBDIRS = \
tests tests
EXTRA_DIST = \ EXTRA_DIST = \
AUTHORS.md \
INSTALL.md \ INSTALL.md \
README.md \ README.md \
dist/osx/DS_Store \ dist/osx/DS_Store \

View File

@ -7,53 +7,47 @@ Spek is available on *BSD, GNU/Linux, Windows and Mac OS X.
Find out more about Spek on its website: <http://www.spek-project.org/> Find out more about Spek on its website: <http://www.spek-project.org/>
## Spek 0.7 - Released 2011-04-24 ## Spek 0.8.0 - Released 2012-TODO
### New Features And Enhancements ### New Features And Enhancements
Spek 0.7 is part of beta 0.x releases, leading up to a stable 1.0 release Spek 0.8.0 is part of beta 0.x releases, leading up to a stable 1.0 release
later this year. Check Spek website for the roadmap. (hopefully) later this year. Check Spek website for the roadmap.
New features since 0.6: New features since 0.7:
* Added translations in 8 languages * Switched from GTK+ to wxWidgets for better Windows and OS X integration.
* Preferences to select a language and to check for a new version * Single .exe version for Windows.
* Spectral density ruler * Added translations in 8 more languages (totalling 16).
* Added a menu bar, cleaned up the tool bar.
* Better OS X integration
Enhancements: Enhancements:
* Show the version number in the window * Switched to .xz tarballs.
* Pre-compute the cosine table to speed up analysis by ±16% * Split out libspek and added unit tests.
* Use jhbuild and ige-mac-bundler to build and package Spek on OS X * 24-bit APE support (upstream fix).
* spek(1) man page
* Avoid using APIs depreciated in GTK3
Bugfixes: Bugfixes:
* Fixed link activation on OS X (issue 31) * Fixed crash when the preferences file is not writable.
* Fixed new version detection on OS X * Fixed crash when the home directory is not writable.
* Fixed duration for unsynchronised ID3v24 mp3 tags (upstream fix) * Fixed duration and rendering for some video files.
* Fixed rigth click → Quit (issue 24) and the ⌘ Q shortcut (issue 44) * Fixed compilation with newer FFmpeg and libav versions.
* Proper handling of Unicode file names under Windows (upstream fix).
### Sources / Packages ### Sources / Packages
* Spek 0.7 tarball: * Spek 0.8.0 tarball:
* <http://spek.googlecode.com/files/spek-0.7.tar.bz2> * <https://github.com/downloads/alexkay/spek/spek-0.8.0.tar.xz>
* Windows and Mac OS X binaries: * Windows and Mac OS X binaries:
* <http://spek.googlecode.com/files/spek-0.7.msi> * <https://github.com/downloads/alexkay/spek/spek-0.8.0.msi>
* <http://spek.googlecode.com/files/spek-0.7.zip> * <https://github.com/downloads/alexkay/spek/spek-0.8.0.zip>
* <http://spek.googlecode.com/files/spek-0.7.dmg> * <https://github.com/downloads/alexkay/spek/spek-0.8.0.dmg>
* Unix packages: * Unix packages:
* <https://github.com/alexkay/spek/blob/master/INSTALL.md> * <https://github.com/alexkay/spek/blob/master/INSTALL.md#bsd-and-gnulinux>
### Dependencies ### Dependencies
* wxWidgets >= 2.8 * wxWidgets >= 2.8
* FFmpeg libraries: * FFmpeg >= 0.7 or libav >= 0.8
* libavcodec >= 52.123
* libavformat >= 52.111
* libavutil

10
dist/README.md vendored
View File

@ -8,16 +8,16 @@
* `tx pull -a`. * `tx pull -a`.
* Update the list of available languages, 80% or so will do: * Update the list of available languages, 80% or so will do:
* po/LINGUAS * po/LINGUAS
* src/spek-preferences-dialog.vala * src/spek-preferences-dialog.cc
* dist/win/bundle.sh * dist/win/bundle.sh
* dist/osx/bundle.sh * dist/osx/bundle.sh
* Update AUTHORS using `git log X.Y.. --pretty=format:"%an <%ae>" | sort -u`. * Update AUTHORS using `git log X.Y.Z. --pretty=format:"%an <%ae>" | sort -u`.
* Sync AUTHORS with the About dialogue. * Sync AUTHORS with the About dialogue.
* Update news in README.md. * Update news in README.md.
* Update the website and debian/control's description with the new features. * Update the website and debian/control's description with the new features.
* Update the manpage if necessary. * Update the manpage if necessary.
* Update sshots if there are user-visible changes. * Update sshots if there are user-visible changes.
* Update and sync wiki pages with the new version number and instructions. * Update INSTALL.md with the new version number and instructions.
* Update copyright year of touched code. * Update copyright year of touched code.
* Commit everything. * Commit everything.
* Make sure `make distcheck` doesn't return errors. * Make sure `make distcheck` doesn't return errors.
@ -26,12 +26,12 @@
* If anything has been changed, commit and re-make the tarball. * If anything has been changed, commit and re-make the tarball.
* Write the blog post, link from web/index.html, don't publish yet. * Write the blog post, link from web/index.html, don't publish yet.
* Update web/index.html: bump version numbers, binary sizes and news. * Update web/index.html: bump version numbers, binary sizes and news.
* `git tag -a X.Y`. * `git tag -a X.Y.Z`.
* Upload the tarball + OSX and WIN binaries. * Upload the tarball + OSX and WIN binaries.
* Update the Ubuntu PPA. * Update the Ubuntu PPA.
* Request FreeBSD and Debian updates. * Request FreeBSD and Debian updates.
* Upload the website using `web/upload`. * Upload the website using `web/upload`.
* Publish the blog post. * Publish the blog post.
* Send an announcement to linux-audio-announce and vala-list. * Send an announcement to the LAA list.
* Update the forum thread on what. * Update the forum thread on what.
* Ping ArchLinux and Gentoo maintainers. * Ping ArchLinux and Gentoo maintainers.

2
dist/win/README.md vendored
View File

@ -1,6 +1,6 @@
## Building the Windows installer ## Building the Windows installer
This is be done in two steps: This is done in two steps:
* Cross-compiling spek.exe using [MXE](http://mxe.cc/). * Cross-compiling spek.exe using [MXE](http://mxe.cc/).
* Building the MSI package under Windows. * Building the MSI package under Windows.