Commits

Wilson Xu committed cd32bb0

Updated README.

  • Participants
  • Parent commits 4cf23ce

Comments (0)

Files changed (4)

 # http://docs.python.org/distutils/sourcedist.html#manifest-template
 # http://docs.python.org/distutils/sourcedist.html#specifying-the-files-to-distribute
-#
-# Tell distutils to distribute following files.
+
+# Including
+include manager.py
 recursive-include fbone/templates *
 recursive-include fbone/static *
 recursive-include fbone/views *
 recursive-include fbone/forms *
 recursive-include fbone/models *
 recursive-include fbone/translations *
+
+# Excluding
+recursive-exclude fbone *.pyc
+recursive-exclude tests *.pyc
+Fbone is a Flask skeleton.
+
+
+- Dependencies:
+    
+    Flask
+    Flask-SQLAlchemy
+    Flask-WTF
+    Flask-Script
+    Flask-Babel
+    Flask-Testing
+    Flask-Uploads
+    Flask-Mail
+    Flask-Cache
+    Flask-Login
+
+    HTML5 Boilerplate
+    bootstrap
+    jQuery
+
+    nose
+
+
+- Commands
+
+    # Install packages.
+    python setup.py install
+
+    # Run local server.
+    python manage.py run
+
+    # Reset database.
+    python manage.py reset
+
+    # Compile with babel.
+    python setup.py compile_catalog --directory fbone/translations --locale zh -f

README.txt

-Fbone
-======
-A Flask skeleton
-Functions
----------
-    Login
-    Remember me
-    Signup
-    Follow
-    Reauth
-    Settings
-    Send email
-    i18n
-    api
-Maintain
---------
-    Unit testing
-    Commands to manipulate database
-    Auto deployment
-    Send email once error occurs
-
-
-Component
-=========
-Flask
-    Flask-SQLAlchemy
-    Flask-WTF
-    Flask-Script
-    Flask-Babel
-    Flask-Testing
-    Flask-Uploads
-    Flask-Mail
-    Flask-Cache
-    Flask-Login
-nose
-HTML5 Boilerplate
-jQuery
-
-
-Install
-=======
-python setup.py install
-
-
-Command
-=======
-Interact with fbone with command line.
-
-# Init
-python manage.py init
-
-# Run local server
-python manage.py run
-
-# Reset database
-python manage.py db
-
-# Compile babel
-python manage.py babel
-
-# Unittest
-python manage.py nose
-
-# Unittest
-python manage.py deploy
-
-
-Compile Babel
-=============
-python setup.py compile_catalog --directory fbone/translations --locale zh -f
     db.session.commit()
 
 
-@manager.command
-def nose():
-    """Run nosetests."""
-
-    tests_folder = os.path.join(project_root_path, 'tests')
-    os.popen('nosetests -s -w %s' % tests_folder)
-
-
-@manager.command
-def deploy():
-    """Deploy with fabric."""
-
-    savedPath = os.getcwd()
-    os.chdir(project_root_path)
-    os.popen('fab deploy')
-    os.chdir(savedPath)
-
-
 manager.add_option('-c', '--config',
                    dest="config",
                    required=False,