- Update
This commit is contained in:
1 parent
d281d765ea
commit
5b074a5176
1261 files changed
+199158
-7303
No files matched your search
Generated
+23
-139
@@ -4,133 +4,14 @@
|
||||
|
||||
CocoaLumberjack
|
||||
===============
|
||||
[](https://travis-ci.org/CocoaLumberjack/CocoaLumberjack)
|
||||
[](https://travis-ci.org/CocoaLumberjack/CocoaLumberjack)
|
||||
[](http://cocoadocs.org/docsets/CocoaLumberjack/)
|
||||
[](https://github.com/Carthage/Carthage)
|
||||
[](http://cocoadocs.org/docsets/CocoaLumberjack/)
|
||||
[](http://opensource.org/licenses/BSD-3-Clause)
|
||||
[](https://www.versioneye.com/objective-c/cocoalumberjack/references)
|
||||
|
||||
**CocoaLumberjack** is a fast & simple, yet powerful & flexible logging framework for Mac and iOS.
|
||||
|
||||
### How to get started
|
||||
- install via [CocoaPods](http://cocoapods.org)
|
||||
|
||||
##### Swift version via CocoaPods
|
||||
```ruby
|
||||
platform :ios, '8.0'
|
||||
pod 'CocoaLumberjack/Swift'
|
||||
use_frameworks!
|
||||
```
|
||||
Note: `Swift` is a subspec which will include all the Obj-C code plus the Swift one, so this is sufficient.
|
||||
For more details about how to use Swift with Lumberjack, see [this converation](https://github.com/CocoaLumberjack/CocoaLumberjack/issues/405).
|
||||
|
||||
##### Swift Usage
|
||||
|
||||
If you installed using CocoaPods or manually:
|
||||
```swift
|
||||
import CocoaLumberjack
|
||||
```
|
||||
|
||||
```swift
|
||||
DDLog.addLogger(DDTTYLogger.sharedInstance()) // TTY = Xcode console
|
||||
DDLog.addLogger(DDASLLogger.sharedInstance()) // ASL = Apple System Logs
|
||||
|
||||
let fileLogger: DDFileLogger = DDFileLogger() // File Logger
|
||||
fileLogger.rollingFrequency = 60*60*24 // 24 hours
|
||||
fileLogger.logFileManager.maximumNumberOfLogFiles = 7
|
||||
DDLog.addLogger(fileLogger)
|
||||
|
||||
...
|
||||
|
||||
DDLogVerbose("Verbose");
|
||||
DDLogDebug("Debug");
|
||||
DDLogInfo("Info");
|
||||
DDLogWarn("Warn");
|
||||
DDLogError("Error");
|
||||
```
|
||||
|
||||
##### Obj-C version via CocoaPods
|
||||
|
||||
```ruby
|
||||
platform :ios, '7.0'
|
||||
pod 'CocoaLumberjack'
|
||||
```
|
||||
|
||||
##### Objc-C usage
|
||||
If you're using Lumberjack as a framework, you can `@import CocoaLumberjack`.
|
||||
|
||||
Otherwise, `#import <CocoaLumberjack/CocoaLumberjack.h>`
|
||||
|
||||
```objc
|
||||
[DDLog addLogger:[DDTTYLogger sharedInstance]]; // TTY = Xcode console
|
||||
[DDLog addLogger:[DDASLLogger sharedInstance]]; // ASL = Apple System Logs
|
||||
|
||||
DDFileLogger *fileLogger = [[DDFileLogger alloc] init]; // File Logger
|
||||
fileLogger.rollingFrequency = 60 * 60 * 24; // 24 hour rolling
|
||||
fileLogger.logFileManager.maximumNumberOfLogFiles = 7;
|
||||
[DDLog addLogger:fileLogger];
|
||||
|
||||
...
|
||||
|
||||
DDLogVerbose(@"Verbose");
|
||||
DDLogDebug(@"Debug");
|
||||
DDLogInfo(@"Info");
|
||||
DDLogWarn(@"Warn");
|
||||
DDLogError(@"Error");
|
||||
```
|
||||
|
||||
##### Installation with Carthage (iOS 8+)
|
||||
|
||||
[Carthage](https://github.com/Carthage/Carthage) is a lightweight dependency manager for Swift and Objective-C. It leverages CocoaTouch modules and is less invasive than CocoaPods.
|
||||
|
||||
To install with Carthage, follow the instruction on [Carthage](https://github.com/Carthage/Carthage)
|
||||
|
||||
Cartfile
|
||||
```
|
||||
github "CocoaLumberjack/CocoaLumberjack"
|
||||
```
|
||||
|
||||
- or [install manually](Documentation/GettingStarted.md#manual-installation)
|
||||
- read the [Getting started](Documentation/GettingStarted.md) guide, check out the [FAQ](Documentation/FAQ.md) section or the other [docs](Documentation/)
|
||||
- if you find issues or want to suggest improvements, create an issue or a pull request
|
||||
- for all kinds of questions involving CocoaLumberjack, use the [Google group](http://groups.google.com/group/cocoalumberjack) or StackOverflow (use [#lumberjack](http://stackoverflow.com/questions/tagged/lumberjack)).
|
||||
|
||||
### CocoaLumberjack 2
|
||||
|
||||
#### Migrating to 2.x
|
||||
|
||||
* Replace `DDLog.h` imports by `#import <CocoaLumberjack/CocoaLumberjack.h>`.
|
||||
|
||||
Advanced users, third party libraries:
|
||||
|
||||
* Replace all `DDLogC` macros for regular `DDLog` macros.
|
||||
* Replace log level (`LOG_LEVEL_*`) macros with `DDLogLevel` enum values
|
||||
* Replace log flag (`LOG_FLAG_*`) macros with `DDLogFlag` enum values
|
||||
* Replace `DDLogMessage` ivars and method calls to the new ivars and methods
|
||||
* `logMsg` with `_message`
|
||||
* `logLevel` with `_level`
|
||||
* `logFlag` with `_flag`
|
||||
* `logContext` with `_context`
|
||||
* `lineNumber` with `_line` (type changed from `int` to `NSUInteger`)
|
||||
* `file` with `_file` (`filename` contains just the file name, without the extension and the full path)
|
||||
* `timestamp` with `_timestamp`
|
||||
* `methodName` with `function`
|
||||
* Replace `DDAbstractLogger` `formatter` to `logFormatter`
|
||||
* `YSSingleFileLogger` ivars are no longer accesible, use the methods instead
|
||||
* Replace `[DDLog addLogger:withLogLevel:]` with `[DDLog addLogger:withLevel:]`
|
||||
|
||||
#### Forcing 1.x
|
||||
|
||||
If an included library requires it, you can force CocoaLumberjack 1.x by setting the version before the conflicting library:
|
||||
|
||||
```ruby
|
||||
pod 'CocoaLumberjack', '~> 1.9'
|
||||
pod 'ConflictingLibrary'
|
||||
```
|
||||
|
||||
### Features
|
||||
|
||||
#### Lumberjack is Fast & Simple, yet Powerful & Flexible.
|
||||
|
||||
It is similar in concept to other popular logging frameworks such as log4j, yet is designed specifically for Objective-C, and takes advantage of features such as multi-threading, grand central dispatch (if available), lockless atomic operations, and the dynamic nature of the Objective-C runtime.
|
||||
@@ -158,30 +39,33 @@ Configure your logging however you want. Change log levels per file (perfect for
|
||||
- You're looking to take your application to the next level in terms of support and stability.
|
||||
- You're looking for an enterprise level logging solution for your application (Mac or iPhone).
|
||||
|
||||
### Documentation
|
||||
### How to get started
|
||||
- install via [CocoaPods](http://cocoapods.org)
|
||||
|
||||
- **[Get started using Lumberjack](Documentation/GettingStarted.md)**<br/>
|
||||
- [Different log levels for Debug and Release builds](Documentation/XcodeTricks.md)<br/>
|
||||
- [Different log levels for each logger](Documentation/PerLoggerLogLevels.md)<br/>
|
||||
- [Use colors in the Xcode debugging console](Documentation/XcodeColors.md)<br/>
|
||||
- [Write your own custom formatters](Documentation/CustomFormatters.md)<br/>
|
||||
- [FAQ](Documentation/FAQ.md)<br/>
|
||||
- [Analysis of performance with benchmarks](Documentation/Performance.md)<br/>
|
||||
- [Common issues you may encounter and their solutions](Documentation/ProblemSolution.md)<br/>
|
||||
- [AppCode support](Documentation/AppCode-support.md)
|
||||
- **[Full Lumberjack documentation](Documentation/)**<br/>
|
||||
```ruby
|
||||
platform :ios, '6.1'
|
||||
pod 'CocoaLumberjack'
|
||||
```
|
||||
- read the [Getting started](https://github.com/CocoaLumberjack/CocoaLumberjack/wiki/GettingStarted) guide, check out the [FAQ](https://github.com/CocoaLumberjack/CocoaLumberjack/wiki/FAQ) section or the other [docs](https://github.com/CocoaLumberjack/CocoaLumberjack/wiki)
|
||||
- if you find issues or want to suggest improvements, create an issue or a pull request
|
||||
- for all kinds of questions involving CocoaLumberjack, use the [Google group](http://groups.google.com/group/cocoalumberjack) or StackOverflow (use [#lumberjack](http://stackoverflow.com/questions/tagged/lumberjack)).
|
||||
|
||||
### Documentation
|
||||
- **[Get started using Lumberjack](https://github.com/CocoaLumberjack/CocoaLumberjack/wiki/GettingStarted)**<br/>
|
||||
- [Different log levels for Debug and Release builds](https://github.com/CocoaLumberjack/CocoaLumberjack/wiki/XcodeTricks)<br/>
|
||||
- [Different log levels for each logger](https://github.com/CocoaLumberjack/CocoaLumberjack/wiki/PerLoggerLogLevels)<br/>
|
||||
- [Use colors in the Xcode debugging console](https://github.com/CocoaLumberjack/CocoaLumberjack/wiki/XcodeColors)<br/>
|
||||
- [Write your own custom formatters](https://github.com/CocoaLumberjack/CocoaLumberjack/wiki/CustomFormatters)<br/>
|
||||
- [FAQ](https://github.com/CocoaLumberjack/CocoaLumberjack/wiki/FAQ)<br/>
|
||||
- [Analysis of performance with benchmarks](https://github.com/CocoaLumberjack/CocoaLumberjack/wiki/Performance)<br/>
|
||||
- [Common issues you may encounter and their solutions](https://github.com/CocoaLumberjack/CocoaLumberjack/wiki/ProblemSolution)<br/>
|
||||
- [AppCode support](https://github.com/CocoaLumberjack/CocoaLumberjack/wiki/AppCode-support)
|
||||
- **[full Lumberjack wiki](https://github.com/CocoaLumberjack/CocoaLumberjack/wiki)**<br/>
|
||||
|
||||
### Requirements
|
||||
The current version of Lumberjack requires:
|
||||
- Xcode 7.1 or later
|
||||
- Xcode 4.4 or later is required
|
||||
- iOS 5 or later
|
||||
- OS X 10.7 or later
|
||||
- WatchOS 2 or later
|
||||
- TVOS 9 or later
|
||||
|
||||
#### Backwards compability
|
||||
- for Xcode 7.0 or earlier, use the 2.1.0 version
|
||||
- for Xcode 6 or earlier, use the 2.0.x version
|
||||
- for OS X < 10.7 support, use the 1.6.0 version
|
||||
|
||||
### Author
|
||||
|
||||
Reference in new issue
Block a user